Scripting reference

// Finds the Scene node using an alias named Scene.
var scene = node.lookupNode('#Scene');
// Creates a Flow Layout 3D node.
var flowLayout = instantiateNode('Kanzi.FlowLayout3D', 'NewFlowLayout');
// Adds the Flow Layout 3D node to the Scene node.
scene.addChild(flowLayout);

// Instantiates a prefab PrefabName as a child of the node from which the Execute Script action is triggered.
// node is a global variable and resolves to this node.
var prefab = instantiatePrefab('kzb://<project_name>/Prefabs/PrefabName', 'NewItem');
node.addChild(prefab);

// Finds the node to which the alias named Item points.
var item = node.lookupNode('#Item');

// Finds the node Text Block 3D, which is relative to the
// node on which you call the method.
var textBlock3D = node.lookupNode('Text Block 3D');

// Prints the value of the Name property of the current node.
// node is a global variable and resolves to this node.
print(node.Name);

// Prints Hello world! to the Log window
print('Hello world!')

// Finds the node Grid List Box 3D called Grid List Box 3D.
var gridListBox = node.lookupNode('Grid List Box 3D');
// Prints to the Log window the number of items in the Grid List Box 3D.
print(gridListBox.getItemCount());

// Finds a mesh named Plane and sets its Texture property to
// the texture located in Textures/Texture01.
var plane = node.lookupNode('Plane');
plane.setProperty('Texture', 'kzb://<project_name>/Textures/Texture01');

// Finds the node to which the TextBlock alias points,
// and sets the value of the Text property in that node to Menu.
var textBlock = node.lookupNode('#TextBlock');
textBlock.Text = 'Menu';
// Sets the Name property of the node to NewName.
textBlock.Name = 'NewName';

// Finds the node to which the TextBlock alias points,
// gets the value of the Text property in that node,
// and prints it to the Log window.
var textBlock = node.lookupNode('#TextBlock');
var text = textBlock.getProperty('TextBlockConcept.Text');
print(text);

// Finds the Image1 and Image2 nodes using a relative path
// from the node where you execute this script.
var image1 = node.lookupNode('../Image1');
var image2 = node.lookupNode('../Image2');
// Sets the value of the Layout Width property in the Image1
// node to the Layout Height property in the Image2 node.
image2.Height = image1.Width;

// Finds the RootPage node using a relative path from
// the node where you execute this script.
var rootPage = node.lookupNode('../../RootPage');
// If in the RootPage node the Default Subpage property is set,
// prints to the Log window the relative path to that node.
if (rootPage.DefaultSubPage)
{
    print(rootPage.DefaultSubPage);
}
else
{
    print("The Default Subpage property is not set!");
}

// Finds the node to which the TextBlock alias points
// and removes the Text property from that node.
var textBlock = node.lookupNode('#TextBlock');
var text = textBlock.removeLocalValue('TextBlockConcept.Text');

// Finds the node to which Point Light alias points
// and sets the Point Light Color property of that node to green.
var light = node.lookupNode('#Point Light');
light.setProperty('PointLightColor.Color', [0, 1, 0, 0]);

// You can set the color of the Color Brush property for a node only
// when that node has the Foreground Brush or Background Brush property
// set to a Color Brush.
// Finds the node to which Button alias points,
// overrides the color set in a Color Brush in the Foreground Brush and Background Brush properties,
// and sets the color of the Color Brush property of the node to red and opaque.
var button = node.lookupNode('#Button');
button.setProperty('ColorBrush.Color', [1, 0, 0, 1]);

// Instantiates a prefab called Sphere and names it NewSphere.
var sphere = instantiatePrefab('kzb://<project_name>/Prefabs/Sphere', 'NewSphere');
// Finds the Empty Node 3D node called Empty Node 3D.
var emptyNode = node.lookupNode('Empty Node 3D');
// Adds the NewSphere node to the Empty Node 3D node.
emptyNode.addChild(sphere);

// Finds the Empty Node 3D node called Empty Node 3D.
var emptyNode = node.lookupNode('Empty Node 3D');
// Gets the second child of the emptyNode node.
emptyNode.getChild(1);

// Finds the Empty Node 3D node called Empty Node 3D.
var emptyNode = node.lookupNode('Empty Node 3D');
// Gets the number of child nodes of the emptyNode.
emptyNode.getChildCount();

// Instantiates a prefab called Sphere and names it NewSphere.
var sphere = instantiatePrefab('kzb://<project_name>/Prefabs/Sphere', 'NewSphere');
// Finds the Empty Node 3D node called Empty Node 3D.
var emptyNode = node.lookupNode('./Empty Node 3D');
// Adds the NewSphere node to the Empty Node 3D node.
emptyNode.addChild(sphere);
// Removes the NewSphere node from the Empty Node 3D node.
emptyNode.removeChild(sphere);

// Finds the node to which EmptyNode alias points.
var emptyNode = node.lookupNode('#EmptyNode');
// Removes all child nodes from the emptyNode node.
emptyNode.removeAllChildren();

// Gets the parent of the current node.
// node is a global variable and resolves to this node.
var parentNode = node.getParent();

// Gets the parent of the current node.
var nodeParent = node.lookupNode('..');

// Instantiates a prefab called Text Block 3D and names it NewText.
var text = instantiatePrefab('kzb://<project_name>/Prefabs/Text Block 3D', 'NewText');
// Finds the Grid List Box 3D node called Grid List Box 3D.
var gridListBox = node.lookupNode('Grid List Box 3D');
// Adds the NewText node to the Grid List Box 3D node.
gridListBox.addItem(text);

// Finds the Grid List Box 3D node called Grid List Box 3D.
var gridListBox = node.lookupNode('Grid List Box 3D');
// Gets the second item of the gridListBox.
gridListBox.getItem(1);

// Finds the Grid List Box 3D node called Grid List Box 3D.
var gridListBox = node.lookupNode('Grid List Box 3D');
// Prints to the Log window the number of items in the Grid List Box 3D.
print(gridListBox.getItemCount());

// Finds the Grid List Box 3D node called Grid List Box 3D.
var gridListBox = node.lookupNode('Grid List Box 3D');
// Removes all items from the Grid List Box 3D node.
gridListBox.removeAllItems();

// Instantiates a prefab called Text Block 3D and names it NewText.
var text = instantiatePrefab('kzb://<project_name>/Prefabs/Text Block 3D', 'NewText');
// Finds the Grid List Box 3D node called Grid List Box 3D.
var gridListBox = node.lookupNode('Grid List Box 3D');
// Adds NewText node to the Grid List Box 3D node.
gridListBox.addItem(text);
// Removes NewText node from the Grid List Box 3D node.
gridListBox.removeItem(text);

// Gets the node that currently has focus.
var nodeInFocus = getFocusedNode();
// Prints to the Log window the Name of the node.
print(nodeInFocus.Name);

// Finds the node to which the Button alias points.
var buttonNode = node.lookupNode('#Button');
// Sets the focus to the buttonNode node.
buttonNode.trySetFocus();

// Moves the focus from the currently focused node to the next child node that has the Focusable property enabled.
// If there is no child node, moves the focus down in the project tree to the next node that has the Focusable property enabled.
tryMoveActiveFocusForward();

// Moves the focus from the currently focused node to the previous child or parent node which has the Focusable property enabled.
// If there is no child or parent node, moves the focus up in the project tree to the next node that has the Focusable property enabled.
tryMoveActiveFocusBackward();

// Moves the focus from the currently focused node to the node specified in the
// Up Navigation Node property.
tryMoveActiveFocusUpward();

// Moves the focus from the currently focused node to the node specified in the
// Down Navigation Node property.
tryMoveActiveFocusDownward();

// Moves the focus from the currently focused node to the node specified in the
// Left Navigation Node property.
tryMoveActiveFocusLeft();

// Moves the focus from the currently focused node to the node specified in the
// Right Navigation Node property.
tryMoveActiveFocusRight();

// Finds the node to which the alias points. The alias can point to either a Page or a Page Host node.
var settingsPageHost = node.lookupNode('#SettingsPageHost');
// Navigates to the settingsPageHost node. 
settingsPageHost.navigateToThisPage();

// Finds the Page Host node to which the alias points.
var applicationsPageHost = node.lookupNode('#ApplicationsPageHost');
// Navigates to the next Page or Page Host child node of the applicationsPageHost node. 
applicationsPageHost.navigateToNextPage();

// Finds the Page Host node to which the alias points.
var applicationsPageHost = node.lookupNode('#ApplicationsPageHost');
// Navigates to the previous Page or Page Host child node of the applicationsPageHost node. 
applicationsPageHost.navigateToPreviousPage();

// Navigates to the parent Page or Page Host node of the current node.
node.navigateToParentPage();

// Finds the node to which the alias points. The alias can point to either a Page or a Page Host node.
var mediaPage = node.lookupNode('#MediaPage');
// Navigates to the parent Page or Page Host node of the mediaPage node. 
mediaPage.navigateToParentPage();

// Gets the value of the Layout Height property of the node where you execute the script.
var height = node.getProperty('Node.Height');

// Checks the value of the Layout Height property.
// If the value of the Layout Height property is less than or equals 50, sets the application
// to the state named Empty in the state group named FuelGauge, which is in the state manager of the current node.
if (height <= 50)
{
	node.goToState('FuelGauge.Empty');
}
// If the value of the Layout Height property is more than 50 and less than or equals 250,
// sets the application to the state named Half in the state group named FuelGauge, which is in the state manager of the current node.
else if (height > 50 && height <= 250)
{
	node.goToState('StateGroup.Half');
}
// For all other values of the Layout Height property, sets the application to the state
// named Full in the state group named FuelGauge, which is in the state manager of the current node.
else
{
	node.goToState('StateGroup.Full');
}

// Sets the next state in the state group named MenuControl of the node where you execute the script.
node.goToNextDefinedState('MenuControl');

// Sets the previous state in the state group named MenuControl of the node where you execute the script.
node.goToPreviousDefinedState('MenuControl');

// Finds the Image node named Photo.
var image = node.lookupNode('Photo');
// Applies 90 degree layout rotation.
text.rotateLayout(90);

// Finds the Text Block 3D node named Text.
var text = node.lookupNode('Text');
// Applies 120 degree rotation around the x axis.
text.rotateXLayout(120);

// Finds the Text Block 3D node named Text.
var text = node.lookupNode('Text');
// Applies 120 degree layout rotation around the y axis.
text.rotateYLayout(120);

// Finds the Text Block 3D node named Text.
var text = node.lookupNode('Text');
// Applies 120 degree layout rotation around the z axis.
text.rotateZLayout(120);

// Finds the Text Block 3D node named Text.
var text = node.lookupNode('Text');
// Sets the layout rotation around the:
// - x axis to 15 degrees
// - y axis to 10 degrees
// - z axis to 0 degrees
text.setLayoutRotation(15, 10, 0);

// Finds the Image node named Photo.
var image = node.lookupNode('Photo');
// Sets the layout rotation to 90 degrees.
image.setLayoutRotation(90);

// Finds the Image node named Photo.
var image = node.lookupNode('Photo');
// Gets the rotation from the Layout Transformation property of the selected node.
var imageRotation = image.getLayoutRotation();

// Finds the Plane node called Plane.
var plane = node.lookupNode('./Viewport 2D/Scene/Plane');
// Extracts the X Euler angle from the Layout Transformation property of the selected node.
var xEulerAngle = plane.extractLayoutTransformEulerX();

// Finds the Button 3D node called Button 3D.
var button = node.lookupNode('./Viewport 2D/Scene/Button 3D');
// Extracts the Y Euler angle from the Layout Transformation property of the selected node.
var yEulerAngle = button.extractLayoutTransformEulerY();

// Finds the Box node called Cube.
var box = node.lookupNode('./Viewport 2D/Scene/Cube');
// Extracts the Z Euler angle from the Layout Transformation property of the selected node.
var zEulerAngle = box.extractLayoutTransformEulerZ();

// Finds the Sphere node named Ball.
var ball = node.lookupNode('Ball');
// Applies the layout scaling of the node:
// - Increases the layout scale in the x axis by 100%.
// - Decreases the layout scale in the y axis by 10%.
// - Increases the layout scale in the z axis by 50%.
ball.scaleLayout(2, 0.9, 1.5);

// Finds the Image node named Photo.
var image = node.lookupNode('Photo');
// Applies the layout scaling of the node:
// - Increases the layout scale in the x axis by 50%.
// - Decreases the layout scale in the y axis by 25%.
image.scaleLayout(1.5, 0.75);

// Finds the Sphere node named Ball.
var ball = node.lookupNode('Ball');
// Sets the layout scale of the node:
// - In the x axis to 200%.
// - In the y axis to 10%.
// - In the z axis to 50%.
ball.setLayoutScale(2, 0.1, 0.5);

// Finds the Image node named Photo.
var image = node.lookupNode('Photo');
// Sets the layout scale of the node:
// - In the x axis to 150%
// - In the y axis to 75%.
image.setLayoutScale(1.5, 0.75);

// Finds the Text Block 3D node named Text.
var text = node.lookupNode('Text');
// Gets the layout scale values for the x, y, and z axes.
text.getLayoutScale();
// Gets the layout scale value only for the x axis.
text.getLayoutScale()[0];
// Gets the layout scale value only for the z axis.
text.getLayoutScale()[2];

// Finds the Image node named Photo.
var image = node.lookupNode('Photo');
// Gets the layout scale values for the x and y.
image.getLayoutScale();
// Gets the layout scale value only for the x axis.
image.getLayoutScale()[0];

// Finds the Sphere node named Ball.
var ball = node.lookupNode('Ball');
// Applies the layout translation of the node:
// - Moves along the x axis by 2 device independent units.
// - Moves along the y axis by 0.5 device independent unit.
// - Moves along the z axis by 0.1 device independent unit.
ball.translateLayout(2, 0.5, 0.1);

// Finds the Image node named Photo.
var image = node.lookupNode('Photo');
// Applies the layout translation of the node:
// - Moves along the x axis by 100 pixels.
// - Moves along the y axis by 50 pixels.
image.translateLayout(100, 50);

// Finds the Sphere node named Ball.
var ball = node.lookupNode('Ball');
// Sets the layout translation of the node:
// - Moves along the x axis by 2 device independent units.
// - Moves along the y axis by 0.5 device independent unit.
// - Moves along the z axis by 0.1 device independent unit.
ball.setLayoutTranslation(2, 0.5, 0.1);

// Finds the Image node named Photo.
var image = node.lookupNode('Photo');
// Sets the layout translation of the node:
// - Moves along the x axis by 100 pixels.
// - Moves along the y axis by 50 pixels.
image.setLayoutTranslation(100, 50);

// Finds the Text Block 3D node named Text.
var text = node.lookupNode('Text');
// Gets the layout translation values for the x, y, and z axes.
text.getLayoutTranslation();
// Gets the layout translation value only for the x axis.
text.getLayoutTranslation()[0];
// Gets the layout translation value only for the z axis.
text.getLayoutTranslation()[2];

// Finds the Image node named Photo.
var image = node.lookupNode('Photo');
// Gets the layout translation value of the node.
image.getLayoutTranslation();
// Gets the layout translation value only for the x axis.
image.getLayoutTranslation()[0];
// Gets the layout translation value only for the y axis.
image.getLayoutTranslation()[1];

// Finds the Image node named Photo.
var image = node.lookupNode('Photo');
// Applies 90 degree render rotation.
text.rotateRender(90);

// Finds the Text Block 3D node named Text.
var text = node.lookupNode('Text');
// Applies 120 degree rotation around the x axis.
text.rotateXRender(120);

// Finds the Text Block 3D node named Text.
var text = node.lookupNode('Text');
// Applies 120 degree render rotation around the y axis.
text.rotateYRender(120);

// Finds the Text Block 3D node named Text.
var text = node.lookupNode('Text');
// Applies 120 degree render rotation around the z axis.
text.rotateZRender(120);

// Finds the Text Block 3D node named Text.
var text = node.lookupNode('Text');
// Sets the render rotation around the:
// - x axis to 15 degrees
// - y axis to 10 degrees
// - z axis to 0 degrees
text.setRenderRotation(15, 10, 0);

// Finds the Image node named Photo.
var image = node.lookupNode('Photo');
// Sets the render rotation to 90 degrees.
image.setRenderRotation(90);

// Finds the Image node named Photo.
var image = node.lookupNode('Photo');
// Gets the rotation from the Render Transformation property of the selected node.
var imageRotation = image.getRenderRotation();

// Finds the Plane node called Plane.
var plane = node.lookupNode('./Viewport 2D/Scene/Plane');
// Extracts the X Euler angle from the Render Transformation property of the selected node.
var xEulerAngle = plane.extractRenderTransformEulerX();

// Finds the Button 3D node called Button 3D.
var button = node.lookupNode('./Viewport 2D/Scene/Button 3D');
// Extracts the Y Euler angle from the Render Transformation property of the selected node.
var yEulerAngle = button.extractRenderTransformEulerY();

// Finds the Box node called Cube.
var box = node.lookupNode('./Viewport 2D/Scene/Cube');
// Extracts the Z Euler angle from the Render Transformation property of the selected node.
var zEulerAngle = box.extractRenderTransformEulerZ();

// Finds the Sphere node named Ball.
var ball = node.lookupNode('Ball');
// Applies the render scaling of the node:
// - Increases the render scale in the x axis by 100%.
// - Decreases the render scale in the y axis by 10%.
// - Increases the render scale in the z axis by 50%.
ball.scaleRender(2, 0.9, 1.5);

// Finds the Image node named Photo.
var image = node.lookupNode('Photo');
// Applies the render scaling of the node:
// - Increases the render scale in the x axis by 50%.
// - Decreases the render scale in the y axis by 25%.
image.scaleRender(1.5, 0.75);

// Finds the Sphere node named Ball.
var ball = node.lookupNode('Ball');
// Sets the render scale of the node:
// - In the x axis to 200%.
// - In the y axis to 10%.
// - In the z axis to 50%.
ball.setRenderScale(2, 0.1, 0.5);

// Finds the Image node named Photo.
var image = node.lookupNode('Photo');
// Sets the render scale of the node:
// - In the x axis to 150%
// - In the y axis to 75%.
image.setRenderScale(1.5, 0.75);

// Finds the Text Block 3D node named Text.
var text = node.lookupNode('Text');
// Gets the render scale values for the x, y, and z axes.
text.getRenderScale();
// Gets the render scale value only for the x axis.
text.getRenderScale()[0];
// Gets the render scale value only for the z axis.
text.getRenderScale()[2];

// Finds the Image node named Photo.
var image = node.lookupNode('Photo');
// Gets the render scale values for the x and y.
image.getRenderScale();
// Gets the render scale value only for the x axis.
image.getRenderScale()[0];

// Finds the Sphere node named Ball.
var ball = node.lookupNode('Ball');
// Applies the render translation of the node:
// - Moves along the x axis by 2 device independent units.
// - Moves along the y axis by 0.5 device independent unit.
// - Moves along the z axis by 0.1 device independent unit.
ball.translateRender(2, 0.5, 0.1);

// Finds the Image node named Photo.
var image = node.lookupNode('Photo');
// Applies the render translation of the node:
// - Moves along the x axis by 100 pixels.
// - Moves along the y axis by 50 pixels.
image.translateRender(100, 50);

// Finds the Sphere node named Ball.
var ball = node.lookupNode('Ball');
// Sets the render translation of the node:
// - Moves along the x axis by 2 device independent units.
// - Moves along the y axis by 0.5 device independent unit.
// - Moves along the z axis by 0.1 device independent unit.
ball.setRenderTranslation(2, 0.5, 0.1);

// Finds the Image node named Photo.
var image = node.lookupNode('Photo');
// Sets the render translation of the node:
// - Moves along the x axis by 100 pixels.
// - Moves along the y axis by 50 pixels.
image.setRenderTranslation(100, 50);

// Finds the Text Block 3D node named Text.
var text = node.lookupNode('Text');
// Gets the render translation values for the x, y, and z axes.
text.getRenderTranslation();
// Gets the render translation value only for the x axis.
text.getRenderTranslation()[0];
// Gets the render translation value only for the z axis.
text.getRenderTranslation()[2];

// Finds the Image node named Photo.
var image = node.lookupNode('Photo');
// Gets the render translation value of the node.
image.getRenderTranslation();
// Gets the render translation value only for the x axis.
image.getRenderTranslation()[0];
// Gets the render translation value only for the y axis.
image.getRenderTranslation()[1];

// Finds the Image node named Photo.
var image = node.lookupNode('Photo');
// Sets the render transformation origin of the node to the
// bottom right corner of the node
image.setRenderTransformationOrigin(1, 1);

// Finds the Image node named Photo.
var image = node.lookupNode('Photo');
// Sets the render transformation origin of the node to the
// center of the node
image.setRenderTransformationOrigin(0.5, 0.5);

// Finds the Image node named Photo.
var image = node.lookupNode('Photo');
// Gets the render transformation origin value of the node.
image.getRenderTransformationOrigin();
// Gets the render translation value only for the x axis.
image.getRenderTransformationOrigin()[0];
// Gets the render translation value only for the y axis.
image.getRenderTransformationOrigin()[1];